package com.danciyixue.boot.dcyx.service;

import com.danciyixue.boot.dcyx.model.entity.UserStudyRecords;
import com.danciyixue.boot.dcyx.model.form.UserStudyRecordsForm;
import com.danciyixue.boot.dcyx.model.form.UserStudyRecordsUpdateForm;
import com.danciyixue.boot.dcyx.model.query.UserStudyRecordsQuery;
import com.danciyixue.boot.dcyx.model.vo.UserStudyRecordsVO;
import com.danciyixue.boot.dcyx.model.vo.WordsVO;
import com.baomidou.mybatisplus.core.metadata.IPage;
import com.baomidou.mybatisplus.extension.service.IService;

import java.util.List;

/**
 * 用户学习记录服务类
 *
 * @author youlaitech
 * @since 2025-06-15 17:26
 */
public interface UserStudyRecordsService extends IService<UserStudyRecords> {

    /**
     *用户学习记录分页列表
     *
     * @return {@link IPage<UserStudyRecordsVO>} 用户学习记录分页列表
     */
    IPage<UserStudyRecordsVO> getUserStudyRecordsPage(UserStudyRecordsQuery queryParams);

    /**
     * 获取用户学习记录表单数据
     *
     * @param id 用户学习记录ID
     * @return 用户学习记录表单数据
     */
     UserStudyRecordsForm getUserStudyRecordsFormData(Long id);

    /**
     * 新增用户学习记录
     *
     * @param formData 用户学习记录表单对象
     * @return 是否新增成功
     */
    boolean saveUserStudyRecords(UserStudyRecordsForm formData);

    /**
     * 修改用户学习记录
     *
     * @param id   用户学习记录ID
     * @param formData 用户学习记录表单对象
     * @return 是否修改成功
     */
    boolean updateUserStudyRecords(Long id, UserStudyRecordsForm formData);

    /**
     * 新增OR修改用户学习记录
     *
     * @param formData 用户学习记录更新表单对象
     * @return 是否操作成功
     */
    boolean saveOrUpdateUserStudyRecords(UserStudyRecordsUpdateForm formData);

    /**
     * 删除用户学习记录
     *
     * @param ids 用户学习记录ID，多个以英文逗号(,)分割
     * @return 是否删除成功
     */
    boolean deleteUserStudyRecordss(String ids);

    /**
     * 获取用户需要复习的单词列表
     *
     * @param programId 教材ID，必须
     * @param unitId 单元ID，可选，如果为null则查询所有单元
     * @param source 来源，必须，取值有 dcjy、dctx、dcmx
     * @return 需要复习的单词列表
     */
    List<WordsVO> getReviewWords(Long programId, Long unitId, String source);

}
